# Captures a Single Auth, Frequent and Frequent Auth

**Required scope:** capture:create

Endpoint: POST /capture/{id}
Version: 2.0
Security: accountId, apiKey

## Security:

  - `accountId` (unknown)
    apiKey in header AccountId

  - `apiKey` (unknown)
    apiKey in header ApiKey

## Path parameters:

  - `id` (string, required)
    Resource Identification

## Request body:

  - `application/json` (unknown)
    Created

## Request fields (application/json):

  - `transaction_key` (string)
    Your internal key identifying this capture
    Example: key example

  - `capture_date` (string)
    The date when the action should be executed. This field specifies the exact day for capturing the transaction, formatted as "YYYY-MM-DD" (e.g., "2024-06-30"). It is optional and defaults to the current date if not specified.
    Example: 2022-11-11

  - `account` (object)
    For multi-account clients.

  - `account.id` (string)
    The uuid of the account.

  - `splits` (array)
    Used in split payments.

  - `splits.split_key` (string)
    A customizable text field for users to input their own identifier for the split.
    Example: Payment of Invoice Nº 1982652

  - `splits.split_descriptive` (string)
    A text field that describes the transaction as it will appear on the end user's account statement. This is typically used to provide clear, recognizable information about the payment, such as "Payment of Invoice Nº 1982652" or "Ticket for Queen".
    Example: Payment of Invoice Nº 1982652

  - `splits.account` (object)
    The account to receive the split funds

  - `splits.account.id` (string, required)
    Example: c6056234-a3f9-42de-b944-3ed793fcb6bb

  - `splits.value` (number, required)
    The monetary amount for the transaction. This field specifies the value of the payment in the designated currency. It must be a positive decimal number representing the exact amount to be processed.
    Example: 17.5

  - `splits.clearing_period` (string)
    The clearing period must follow the format 1Y, 10W or 30D. Y for Years, W for weeks, D for days. Minimum is 7 days, maximum is 1 year.
    Example: 30D

  - `splits.margin_account` (object)
    The account to which the margin value should be routed. This field specifies the destination account for the margin portion of the funds, ensuring that the correct recipient receives the designated margin value.

  - `splits.margin_account.id` (string, required)
    Example: c6056234-a3f9-42de-b944-3ed793fcb6bb

  - `splits.margin_value` (number)
    The margin amount to be deducted from this split
    Example: 0.25

  - `splits.reward` (object)
    Reward credits to generate from this split. The credits are associated with the customer provided at the top level of the payment request and can only be redeemed by that customer. Reward funds expire after the specified period. Only available on the payment methods `CC`, `MBW`, `AP`, `GP`, `SW`, and `IPP`. See the [Rewards & Redemptions guide](/docs/guides/rewards-and-redemptions) for the full flow.

  - `splits.reward.account` (object, required)
    The account to which the reward credits should be routed.

  - `splits.reward.account.id` (string, required)
    Example: c6056234-a3f9-42de-b944-3ed793fcb6bb

  - `splits.reward.value` (number, required)
    The reward amount to be generated from this split.
    Example: 1

  - `splits.reward.expiration_date` (string)
    The date until which the reward credits are valid. Defaults to 12 months from the transaction date if not specified.
    Example: 2027-04-02

  - `reward_redemption` (object)
    Apply accumulated reward credits to reduce the payment value. Supports full or partial redemption of available reward balance. Only available on the payment methods `CC`, `MBW`, `AP`, `GP`, `SW`, and `IPP`. See the [Rewards & Redemptions guide](/docs/guides/rewards-and-redemptions) for the full flow.

  - `reward_redemption.account` (object, required)
    The reward account to debit credits from.

  - `reward_redemption.account.id` (string, required)
    Example: c6056234-a3f9-42de-b944-3ed793fcb6bb

  - `reward_redemption.value` (number, required)
    The reward amount to apply. Must not exceed the available reward balance or the payment value.
    Example: 2.5

  - `force_3ds` (boolean)
    Whether or not you want to force the 3DS authentication on Credit Cards (used only on Frequent capture without authorisation).

  - `descriptive` (string)
    This will appear in the bank statement/MB WAY application.
    Example: descriptive example

  - `value` (number)
    Value will be rounded to 2 decimals.
    Example: 20.55

## Response 201:

  - `201` (unknown)
    Created

## Response 201 fields (application/json):

  - `status` (string)
    Example: ok

  - `message` (array)

  - `id` (string)
    A unique identifier for the resource. While typically formatted as a UUID (Universally Unique Identifier), it can also be in other formats as defined by the user. This field ensures the resource can be distinctly recognized and referenced.
    Example: 677dbec9-ec19-4a78-9e08-3d2901c7a32b

## Response 400:

  - `400` (unknown)
    Bad Request

## Response 400 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 403:

  - `403` (unknown)
    Forbidden

## Response 403 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 403 fields (application/xml):

  - `message` (array)

## Response 404:

  - `404` (unknown)
    Not Found

## Response 404 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 412:

  - `412` (unknown)
    Pre condition failed

## Response 412 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 422:

  - `422` (unknown)
    Unprocessable Entity

## Response 422 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 428:

  - `428` (unknown)
    Pre condition required

## Response 428 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 429:

  - `429` (unknown)
    Too Many Requests

## Response 429 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 500:

  - `500` (unknown)
    Internal Server Error

## Response 500 fields (application/json):

  - `status` (string, required)

  - `message` (array, required)
    An array of human-readable messages included in the response. These messages provide detailed information about the success of the operation or explain the reasons for any failure. This field is always present in the response to ensure clarity and transparency regarding the outcome of the API request.

## Response 403 examples:

  - `Wrong credentials provided` (unknown)

## Response 404 examples:

  - `Resource not found` (unknown)

## Response 412 examples:

  - `Domain constraint failed` (unknown)

## Response 422 examples:

  - `Rate limit exceeded` (unknown)

## Response 428 examples:

  - `Domain constraint failed` (unknown)

## Response 429 examples:

  - `Rate limit exceeded` (unknown)

## Response 500 examples:

  - `Internal error` (unknown)